docs(site): fill out guide and reference pages from README#21
Merged
Conversation
Migrates the README's depth content into the VitePress site, expanding each page to be useful as standalone documentation. Stubs replaced with real content; the README becomes the source of truth for the short version (to be trimmed in a follow-up PR that closes the loop). Pages filled: - guide/getting-started — install, deploy-the-worker-bundle (with code-group for Vite/Next/Webpack), construct + start walkthrough, send/receive, two-tab verification, React quickstart, troubleshooting - guide/architecture — primary mode diagram, fallback mode strategy ladder, outbox semantics, Service Worker handoff, inbound flow, identity, boundary section, cross-links to ADRs - guide/gotchas — six full sections (worker name caching, delivered- semantics, no-replay-buffer, browser-only, mobile coverage, SW delivery URL) plus a bonus "drain doesn't re-fan-out on reconnect" section. PR cross-links for backstory - guide/react — provider setup, useTabMesh and useTabMeshEvent in depth, status shape table, common patterns (connection badge, remote-only handling, logout) - reference/config — required + transport + worker + persistence + SW + leader + per-event option sections; defaults inline; cross- references to gotchas where applicable; full example at the bottom - reference/system-events — per-event documentation: hub.connected, hub.disconnected, transport.* (4), event.delivery.failed, storage.degraded; meta-field reference; wildcard subscription pattern Verified: `pnpm docs:build` clean, biome clean. README is unchanged in this commit — it gets trimmed in the next PR once the docs site is live and we can link to it from the README.
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Step 3 in the docs-site work. Replaces the placeholder stubs from PR #20 with real content. ~950 lines of documentation across six pages.
The README is untouched in this PR — it gets trimmed in the next PR once the docs site is live and we can link out to it.
What got filled
Guide
Reference
Test plan
Follow-ups (not in this PR)